Kotlin Computational Geometry/io.github.cponfick.kompgeom.core.shapes/Polygon

Polygon

interface Polygon<V : Vector<V>> : Spatial(source)

Represents a polygon in a vector space.

A polygon is defined by an ordered list of vertices that form a closed shape. The polygon can exist in any dimensional space (2D, 3D, etc.) as determined by the vector type.

Parameters

The type of vector representing the vertices of the polygon.

Inheritors

Polygon3

Polygon2

Properties

vertexCount

open val vertexCount: Int

Returns the number of vertices in the polygon.

vertices

abstract val vertices: List<V>

Returns the list of vertices defining the polygon.

Functions

area

abstract fun area(): Double

Computes the area of the polygon.

centroid

abstract fun centroid(): V

Computes the centroid (geometric center) of the polygon.

contains

abstract fun contains(point: V): Boolean

Checks if a point is inside the polygon.

dimensions

abstract fun dimensions(): Int

Returns the number of dimensions of the spatial object.

isConvex

abstract fun isConvex(): Boolean

Checks if the polygon is convex.

isFinite

abstract fun isFinite(): Boolean

Returns true if all values in the spatial are finite.

isInfinite

abstract fun isInfinite(): Boolean

Returns true if any value in the spatial is infinite.

isNaN

abstract fun isNaN(): Boolean

Returns true if any value in the spatial is NaN (Not a Number).

isSimple

abstract fun isSimple(): Boolean

Checks if the polygon is simple (non-self-intersecting).

perimeter

abstract fun perimeter(): Double

Computes the perimeter of the polygon.

reverse

abstract fun reverse(): Polygon<V>

Reverses the order of vertices, effectively reversing the orientation of the polygon.

scale

abstract fun scale(factor: Double, center: V): Polygon<V>

Scales the polygon by a given factor around a center point.

signedArea

abstract fun signedArea(): Double

Computes the signed area of the polygon.

transform

abstract fun transform(transformer: Transformer<V>): Polygon<V>

Transforms the polygon by applying a transformation to all vertices.

translate

abstract fun translate(offset: V): Polygon<V>

Translates the polygon by a given offset vector.